FlowMail Methods
An object defining methods for the FlowMail class.
AddConstantPosition(id, code, description)
Adds a constant position to the workflow mail group with additional details.
Parameters:
id (required): long
The unique identifier of the position to be added.
code (required): string
The code of the position to be added.
description (required): string
The description of the position to be added.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
AddConstantPosition(id)
Adds a constant position to the workflow mail group using its ID.
Parameters:
id (required): long
The unique identifier of the position to be added.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
AddConstantUser(id)
Adds a constant user to the workflow mail group using their ID.
Parameters:
id (required): long
The unique identifier of the user to be added.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
Initialize()
Initializes the workflow mail step with necessary configurations.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
AddAttachment(value,type)
Adds an attachment to the mail message.
Parameters:
value (required): string
Value of the attachment.
type (required): MailAttachmentType
Type of the attachment.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
ClearMembers()
Clears all members, positions, and related settings from the workflow mail group.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
RemoveDocument(flowDocument)
Removes a document from the workflow mail group.
Parameters:
flowDocument (required): FlowDocument
The document to be removed from the workflow mail group.
Returns:
Type: bool
Returns true if the document was removed successfully, otherwise false.
This is a sync method. Method runs synchronously.
RemovePosition(id)
Removes a constant position from the workflow mail group using its ID.
Parameters:
id (required): long
The unique identifier of the position to be removed.
Returns:
Type: bool
Returns true if the position was removed successfully, otherwise false.
This is a sync method. Method runs synchronously.
SendPushNotification(userInfo,requestItem)
Sends a push notification to a user.
Parameters:
userInfo (required): UserInfo
The user to whom the push notification will be sent.
requestItem (required): ProcessRequestItem
The process request item associated with the notification.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SendInformationWebNotification(userInfo, requestItem)
Sends a web notification to inform the user about a process request.
Parameters:
userInfo (required): UserInfo
Information about the user who will receive the notification.
requestItem (required): ProcessRequestItem
The process request item triggering the notification.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
RemoveUser(id)
Removes a user from the workflow mail group by their ID.
Parameters:
id (required): long
The unique identifier of the user to be removed.
Returns:
Type: bool
Returns true if the user was removed successfully, otherwise false.
This is a sync method. Method runs synchronously.
Send(userInfo, requestItem)
Sends an email to the specified user based on the process request.
Parameters:
userInfo (required): UserInfo
Information about the user who will receive the email.
requestItem (required): ProcessRequestItem
The process request item triggering the email.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
AddDocument(flowDocument, viewName, viewId, panelSize)
Adds a document to the workflow mail group with specified view and display settings.
Parameters:
flowDocument (required): FlowDocument
The document to be added to the workflow mail group.
viewName (optional): string
The name of the view associated with the document.
viewId (optional): string
The ID of the view associated with the document.
panelSize (optional): PanelSize
The size of the panel where the document will be displayed.
Returns:
Type: bool
Returns true if the document was added successfully, otherwise false.
This is a sync method. Method runs synchronously.
AddConstantUser(id, code, name)
Adds a constant user to the workflow mail group with additional details.
Parameters:
id (required): long
The unique identifier of the user to be added.
code (required): string
The code of the user to be added.
name (required): string
The name of the user to be added.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SendWebNotification(payloadType,userInfo,requestItem)
Sends a web notification to a user.
Parameters:
payloadType (required): MessagePayloadType
The type of the web notification payload.
userInfo (required): UserInfo
The user to whom the web notification will be sent.
requestItem (required): ProcessRequestItem
The process request item associated with the notification.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.